feat: Add opengrep migration docs CF-2184#2586
Conversation
|
Overall readability score: 54.12 (🔴 -0.08)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Codacy's Analysis Summary0 new issue (≤ 0 minor issue) Review Pull Request in Codacy →
|
There was a problem hiding this comment.
Pull request overview
This pull request migrates the documentation from Semgrep to Opengrep following licensing changes to Semgrep. Opengrep is an open-source fork of the Semgrep engine that Codacy is adopting as a 1:1 replacement. The PR updates tool references, URLs, and adds release notes explaining the migration while preserving backward compatibility through unchanged configuration file names.
Changes:
- Added release notes documenting the Semgrep to Opengrep migration
- Updated all tool name references from "Semgrep" to "Opengrep" across documentation files
- Updated repository URLs from codacy/codacy-semgrep to codacy/codacy-opengrep and external links from semgrep.dev to github.com/opengrep/opengrep
- Removed Semgrep Pro references from footnotes and updated anchor references from #semgrep to #opengrep
- Updated vocabulary file to include Opengrep and remove Semgrep
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/release-notes/cloud/cloud-2026-02-migrating-semgrep.md | New release notes file explaining the migration from Semgrep to Opengrep |
| docs/release-notes/index.md | Added link to the new migration release notes |
| docs/repositories-configure/languages.md | Updated reference to Opengrep for custom file extensions note |
| docs/repositories-configure/configuring-code-patterns.md | Updated tool name in configuration files table |
| docs/repositories-configure/codacy-configuration-file.md | Updated tool name in configuration list and deprecation references |
| docs/organizations/managing-security-and-risk.md | Updated tool name and URLs in security tools table, removed Semgrep Pro footnote |
| docs/getting-started/supported-languages-and-tools.md | Comprehensive updates to tool names, URLs, anchor references, and footnotes across the languages table |
| .github/styles/config/vocabularies/Codacy/accept.txt | Added Opengrep and removed Semgrep from accepted vocabulary |
Comments suppressed due to low confidence (1)
docs/repositories-configure/codacy-configuration-file.md:225
- Consider adding a deprecation notice for 'semgrep' in the deprecated tools list, similar to other replaced tools like 'bundleraudit'. This would help users who have 'semgrep' in their Codacy configuration files understand that they should migrate to using 'opengrep' instead. For example:
- semgrep - Use the name opengrep for Opengrep.
The following names are **deprecated** and shouldn't be used, although they're still accepted in the Codacy configuration file:
- `bundleraudit` - The tool **bundler-audit** [is deprecated](../release-notes/cloud/cloud-2023-10-13-bundler-audit-deprecation.md). If you are using **Opengrep** or **Trivy** instead, use the names `trivy` or `opengrep`.
- `csslint` - The tool **CSSLint** [is deprecated](../release-notes/cloud/cloud-2023-10-25-csslint-jshint-fauxpas-tailor-tslint-deprecation.md). If you are using **Stylelint** instead, use the name `stylelint`.
- `eslint` - Use the name `eslint-8` for **ESLint**.
- `jshint`, `tslint` - The tools **JSHint** and **TSLint** [are deprecated](../release-notes/cloud/cloud-2023-10-25-csslint-jshint-fauxpas-tailor-tslint-deprecation.md). If you are using **ESLint** instead, use the name `eslint-8`.
- `pylint` - Use the name `pylintpython3` for **Pylint**.
- `tailor` - The tool **Tailor** [is deprecated](../release-notes/cloud/cloud-2023-10-25-csslint-jshint-fauxpas-tailor-tslint-deprecation.md). If you are using **SwiftLint** instead, use the name `swiftlint`.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull Request Overview
The PR successfully updates the documentation for the Semgrep to Opengrep migration. It is generally up to standards. I have identified some inconsistencies where Opengrep was added to the main supported tools table but missed in the 'Languages checked for security issues' table for specific languages (AWS CloudFormation, Helm, Kubernetes). There are also minor grammatical and formatting nitpicks in the new release notes and footnote spacing.
Test plan proposal
- Verify that the Opengrep GitHub links (
https://github.com/opengrep/opengrep/) are valid and resolve correctly. - Confirm that footnote references (e.g.,
<sup>1</sup>) correctly navigate to the intended span IDs on each page where they were updated. - Ensure that the new release note file is correctly indexed and accessible from the main release notes index page.
- Audit the 'Security and risk management' table to ensure Opengrep is present for all languages listed in the 'Supported tools' main table.
About this PR
- The description is sufficient for context given the Jira key, but consider adding a brief summary of the migration (forking of Semgrep) to the description for clarity in the git history.
💡 Codacy uses AI. Check for mistakes.
👀 Live preview
🚧 To do